Analytics

PTV Drive&Arrive creates a protocol of (all) relevant operations. The following method provides a statistical overview about these journals .

/analytics/data/tourlist GET - get a summary about journals of multiple trips

parameters:

• from: time window from (not yet implemented, optional if scemids are given)
• until: time window until (not yet implemented, optional if scemids are given)
• scemids: comma separated list of tour SCEMIDs (mandatory until from and until are implemented)
• sortOrderTourCreationTime: optional, sort by tourCreationTime. Possible values ASC or DESC. If not set or unknown DEFAULT=DESC (newest trips first)
• itemsPerPage: maximum results per page (max. 50) (not yet implemented)
• startIndex: skip the first n results. Index starts with 0 (not yet implemented)
• token: mandatory, identifies the customer of PTV Drive&Arrive
• source: optional, arbitrary text to identify the component that updated the location

returns:

• (an array of tourData)
  • scemid - identifier of tour/trip
  • analyzedTourInfos
    • ...
    • roundTrip - first and last stop have the same coordinates
  • analyzedCountInfos - number of different entries in journal
  • analyzedEtaOKInfo
    • tourEtaOKState - if ETA is within +/- 15 minutes form time arrived via geofencing
    • tourOnTimeState - arrived within time window
    • analyzedStopsETAInfo - ETA details about each stop
  • analyzedEventVisibility - was tracing activated
  • arrived_Done - each stop at least one ARRIVED event
  • arrived_StopOrder - ARRIVED events sorted by time are in the same order as planned
  • arrived_GeofenceOrder- coordinates of ARRIVED events are less than 75 meters apart from planned stop coordinate
  • duration - time from first to last event
  • readableTourDuration - duration in human readable style

{
	"responseStatus": {
		"errorCode": "SUCCESS",
		"message": "0a0a0a0a0a0a0a0a0a0a0a0a0a0a0a0a"
	},
	"tourData": [{
		"scemid": "X9X9X9X9X9",
		"analyzedTourInfos": {
			"tourCreateTime": "2016-11-28T14:56:43.0000000+00:00",
			"stopCount": 10,
			"roundTrip": true,
			"destination": "Deutschland 76131 Karlsruhe Stumpfstraße 1"
		},
		"analyzedCountInfos": {
			"journalCount": 16,
			"tourCreatedCount": 1,
			"positionCount": 1,
			"statusArrivedCount": 0,
			"statusDepartedCount": 0,
			"etaInfoCount": 12,
			"notificationCount": 0,
			"tourDeletedCount": 0,
			"stopDeletedCount": 0,
			"subscriptionCreatedCount": 0,
			"subscriptionRemovedCount": 0,
			"subscriptionConfirmationCount": 0
		},
		"analyzedEtaOKInfo": {
			"tourEtaOKState": "ETA_STATE_TOUR_OK",
			"tourOnTimeState": "ETA_STATE_TOUR_NOT_ON_TIME",
			"analyzedStopsETAInfo": [
				{
					"scemid": "WINWGBF3S4",
					"stopApproached": "ETA_STATE_STOP_NOT_APPROACHED",
					"stopEtaOKState": "ETA_STATE_STOP_NOT_APPROACHED",
					"arrived_Done": "STOP_DONE_NOT_ARRIVED",
					"arrived_StopOrder": "ANALYZED_STOP_ARRIVED_STATE_UNKNOWN",
					"arrived_GeofenceOrder": "ANALYZED_STOP_ARRIVED_STATE_UNKNOWN",
					"lowerBound": "0001-01-01T00:00:00.0000000+00:00",
					"upperBound": "0001-01-01T00:00:00.0000000+00:00",
					"earliestArrivalTime": "2016-11-29T04:00:00.0000000+01:00",
					"latestDepartureTime": "2016-11-29T22:00:00.0000000+01:00",
					"onTime": "ETA_STATE_STOP_NOT_ON_TIME"
				},
				{
					...
				}
			]
		},
		"analyzedEventVisibility": {
			"analyzedEventsVisibility": "ANALYZED_EVENT_VISIBILITY_ALL",
			"visible": 1,
			"notVisible": 0
		},
		"arrived_Done": "TOUR_DONE_STOPS_NONE_ARRIVED",
		"arrived_StopOrder": "ANALYZED_TOUR_ARRIVED_STATE_UNKNOWN",
		"arrived_GeofenceOrder": "ANALYZED_TOUR_ARRIVED_STATE_UNKNOWN",
		"duration": 0,
		"readableTourDuration": "0d 0h 0m 0s"
	}]
}
		

Exceptions

validation / message	errorCode
Token does not exist.	TOKEN_ERROR
Token is blocked. Please contact support in order to get further information.	TOKEN_BLOCKED
The validation date of the token is expired.	TOKEN_EXPIRED
API: Parameter error, SCEMIDs invalid|0a0a0a0a0a0a0a0a0a0a0a0a0a0a0a0a	ERROR